dxp-ux
customerBill(TMF678 GET) retriveCustomerBills - V1
CASE 1 Unitary Test
This use case is to retrieve bill history from evertec
URL
https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v1/PR/customerBill
URI Param
name | type | description | required |
---|---|---|---|
businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
Query Param
name | type | description | required |
---|---|---|---|
billingAccount.id | string | customer account id, without any "-" | Y |
relatedParty.id | string | describes the billing provider as a related party playing the role of organization example 002 for AT&T and 001 for Liberty | Y |
Header
name | value | description | required |
---|---|---|---|
client_id | string | The client_id identifying the channel. | Y |
client_secret | string | Password associated with the client_id. | Y |
X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | Y |
targetSystem | string | Target system identifier Allowed values are "EVERTEC" | Y |
lob | string | Defines the line of business Allowed values are "POSTPAID" | Y |
channelId | string | Source system identifier allowed values are "APP" | Y |
Request
curl --location 'https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v1/PR/customerBill?billingAccount.id=821470133&relatedParty.id=002' \
--header 'client_id: xxx' \
--header 'client_secret: yyy' \
--header 'X-Correlation-ID: 26565-56255-4245625' \
--header 'targetSystem: EVERTEC' \
--header 'lob: POSTPAID' \
--header 'channelId: APP'
Response
200 OK
[
{
"id": "265479404",
"billDocument": [
{
"id": "2"
}
],
"billDate": "2024-04-18"
},
{
"id": "261621184",
"billDocument": [
{
"id": "2"
}
],
"billDate": "2024-03-18"
}
]
Field Definitions
name | value | description | required |
---|---|---|---|
id | string | Bill Id | N |
billDocument | array | array object of bill document | N |
billDocument.id | string | Type of the bill document Expected values are 1 is for Liberty or 2 is for AT&T | N |
billDate | string | Bill Date example "2024-01-10" | N |